// Copyright 2018 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_OBJECTS_ODDBALL_H_
#define V8_OBJECTS_ODDBALL_H_

#include "src/objects/heap-object.h"
#include "torque-generated/class-definitions-from-dsl.h"

// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"

namespace v8 {
namespace internal {

    // The Oddball describes objects null, undefined, true, and false.
    class Oddball : public HeapObject {
    public:
        // [to_number_raw]: Cached raw to_number computed at startup.
        inline double to_number_raw() const;
        inline void set_to_number_raw(double value);
        inline void set_to_number_raw_as_bits(uint64_t bits);

        // [to_string]: Cached to_string computed at startup.
        DECL_ACCESSORS(to_string, String)

        // [to_number]: Cached to_number computed at startup.
        DECL_ACCESSORS(to_number, Object)

        // [typeof]: Cached type_of computed at startup.
        DECL_ACCESSORS(type_of, String)

        inline byte kind() const;
        inline void set_kind(byte kind);

        // ES6 section 7.1.3 ToNumber for Boolean, Null, Undefined.
        V8_WARN_UNUSED_RESULT static inline Handle<Object> ToNumber(
            Isolate* isolate, Handle<Oddball> input);

        DECL_CAST(Oddball)

        // Dispatched behavior.
        DECL_VERIFIER(Oddball)

        // Initialize the fields.
        static void Initialize(Isolate* isolate, Handle<Oddball> oddball,
            const char* to_string, Handle<Object> to_number,
            const char* type_of, byte kind);

        DEFINE_FIELD_OFFSET_CONSTANTS(HeapObject::kHeaderSize,
            TORQUE_GENERATED_ODDBALL_FIELDS)
        // TODO(v8:8989): [torque] Support marker constants.
        static const int kTaggedFieldsStartOffset = kToStringOffset;
        static const int kTaggedFieldsEndOffset = kKindOffset;

        static const byte kFalse = 0;
        static const byte kTrue = 1;
        static const byte kNotBooleanMask = static_cast<byte>(~1);
        static const byte kTheHole = 2;
        static const byte kNull = 3;
        static const byte kArgumentsMarker = 4;
        static const byte kUndefined = 5;
        static const byte kUninitialized = 6;
        static const byte kOther = 7;
        static const byte kException = 8;
        static const byte kOptimizedOut = 9;
        static const byte kStaleRegister = 10;
        static const byte kSelfReferenceMarker = 10;

        using BodyDescriptor = FixedBodyDescriptor<kTaggedFieldsStartOffset,
            kTaggedFieldsEndOffset, kSize>;

        STATIC_ASSERT(kKindOffset == Internals::kOddballKindOffset);
        STATIC_ASSERT(kNull == Internals::kNullOddballKind);
        STATIC_ASSERT(kUndefined == Internals::kUndefinedOddballKind);

        OBJECT_CONSTRUCTORS(Oddball, HeapObject);
    };

} // namespace internal
} // namespace v8

#include "src/objects/object-macros-undef.h"

#endif // V8_OBJECTS_ODDBALL_H_
